Skip to content

docs(integrations): list Utilization & Health and the trace heatmap for Splunk Enterprise - #936

Open
reckless-sherixx wants to merge 1 commit into
mainfrom
docs/splunk-enterprise-heatmap-utilization-webhook
Open

reckless-sherixx wants to merge 1 commit into
mainfrom
docs/splunk-enterprise-heatmap-utilization-webhook

Conversation

@reckless-sherixx

Copy link
Copy Markdown

Summary

The Splunk Enterprise page left out three things readers look for:

  • Utilization & Health. Nothing said that the cluster Summary card, its Trend charts and a workload's Utilization Trends tab read Splunk metrics, or which metric names they need. The Metrics section now says so, with a table of the metric names NudgeBee checks for each value, in order.
  • Trace heatmap. The page called it "the span waterfall", so a search for "heatmap" found nothing. It now names it as a trace's Service & Operation tab (its Trace Chart).
  • Splunk alerts. The page said alerts do not become events, with no pointer. The Notes section now links the Splunk Webhook page, and says its tile is grayed out so a new connection cannot be added. That matches the note on the Splunk Webhook page itself.

Verify the Integration gains a Utilization & Health step.

Each statement was checked against a running NudgeBee with Splunk Enterprise as the account's metrics and traces provider:

  • The Utilization & Health figures matched an mstats query run directly in Splunk (3 nodes, 12 cores, 48 GiB).
  • Trend drew Usage, Total, Request and Limit.
  • A workload's Utilization Trends tab drew its CPU and memory charts.
  • A trace's Service & Operation tab drew its spans.
  • The Splunk Webhook tile was grayed out.

The metric-name table is copied from the lookup order in the server code.

Type of change

  • Update to existing documentation

Checklist

  • I ran npm run build locally and the site builds without errors
  • I ran npm run lint locally and lint passes
  • Internal links work; new external links open the correct page (the new Splunk Webhook link resolves; no new external links)
  • My commits are signed off (DCO — git commit -s)
  • I read CONTRIBUTING.md

…or Splunk Enterprise

The Splunk Enterprise page did not say that the cluster Utilization &
Health card, the Trend charts and a workload's Utilization Trends tab
read Splunk metrics, or which metric names they look for. It called the
trace heatmap "the span waterfall", so a search for "heatmap" found
nothing. And it said Splunk alerts do not become events without pointing
to the Splunk Webhook integration, which does that.

- Metrics: describe Utilization & Health and add the metric-name table
- Traces: name the heatmap as the trace's Service & Operation tab
- Verify: add a Utilization & Health step
- Notes: link the Splunk Webhook page and say its tile is grayed out

Signed-off-by: reckless-sherixx <141176362+reckless-sherixx@users.noreply.github.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the Splunk Enterprise integration documentation to detail how utilization and health metrics are read, including a table of the specific Splunk metric names checked. It also documents support for the trace heatmap, adds a verification step for utilization metrics, and clarifies how Splunk alerts can be integrated via webhooks. The review feedback suggests minor grammatical and terminology improvements to enhance clarity and maintain parallel structure, specifically by rephrasing the metrics provider configuration description and changing 'requested' to 'request' in the workload utilization description.


What uses Splunk metrics:

- **Utilization & Health.** When Splunk Enterprise is the account's metrics provider, which **Default Metrics Provider** sets, the cluster and workload utilization views read the metric index:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrase "which Default Metrics Provider sets" is grammatically awkward. It is clearer to refer to it as a setting.

Suggested change
- **Utilization & Health.** When Splunk Enterprise is the account's metrics provider, which **Default Metrics Provider** sets, the cluster and workload utilization views read the metric index:
- **Utilization & Health.** When Splunk Enterprise is the account's metrics provider (configured via the **Default Metrics Provider** setting), the cluster and workload utilization views read the metric index:
References
  1. Use US English spelling consistently throughout the documentation (e.g., 'utilization' instead of 'utilisation').


- **Utilization & Health.** When Splunk Enterprise is the account's metrics provider, which **Default Metrics Provider** sets, the cluster and workload utilization views read the metric index:
- On the cluster's **Summary** tab, the **Utilization & Health** card shows CPU and memory **Total**, **Usage**, **Request**, **Limit**, **P50 Usage**, **P90 Usage**, and **Max Usage**. **Trend** charts usage, total, request, and limit over the selected time range.
- On a workload's **Utilization Trends** tab, the CPU and memory charts show its usage, requested, and limit.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Use "request" instead of "requested" to maintain parallel noun structure with "usage" and "limit", and to remain consistent with the terminology used in the previous bullet point.

Suggested change
- On a workload's **Utilization Trends** tab, the CPU and memory charts show its usage, requested, and limit.
- On a workload's **Utilization Trends** tab, the CPU and memory charts show its usage, request, and limit.
References
  1. Use US English spelling consistently throughout the documentation (e.g., 'utilization' instead of 'utilisation').

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant